DataGrid.hitTest Method

Determines what data control element is represented at the specified position.
 

Parameters

offsetX

Type: Number
The position to test in pixels relative to the left edge of the data grid container.
offsetY

Type: Number
The position to test in pixels relative to the top edge of the data grid container.
element

Type: HTMLElement
The HTML element located at the position, if available.
Optional: True

Return Value


Type: Object - May be null
If not null, a plain object with properties:
     type                        [type: String]                          - Type of cell
     rowOrdinals                 [type: Array, elementType: Number]      - The row tuple ordinals
     columnOrdinals              [type: Array, elementType: Number]      - The column tuple ordinals
     columnCustomizationIndex    [type: Number, mayBeNull: true]         - The column customization index
     rowIndex                    [type: Number]                          - Row index of the cell
     colIndex                    [type: Number]                          - Column index of the cell
     left                        [type: Number, mayBeNull: true]         - Left coordinate of the cell
     top                         [type: Number, maybeNull: true]         - Top coordinate of the cell
     isLastColumnHeaderRow       [type: Boolean]                         - Cell in the last row of column header
     width                       [type: Number]                          - Selection width
     height                      [type: Number]                          - Selection width
     cell                        [type: HTMLElement, mayBeNull: true]    - Selected cell    
     member                      [type: Object, mayBeNull: true]         - Selected cell's member
     isFrozen                    [type: Boolean]                         - Selected cell in the frozen column
     isGroup                     [type: Boolean, mayBeNull: true]        - Selected cell is a group header
     isExpander                  [type: Boolean, mayBeNull: true]        - The cell's expander button was the target